Skip to main content
Version: 5.1.1.0

Housekeeping

System Events​

These events are accessible by selecting the "System Events" option in the monitor.

SystemEvent​

Define a list of housekeeping configurations. These names are solely for referencing the configuration, and any name can be used. Configure the following parameters for each name in this list (replace %% with the name).

ParameterDescription
SystemEvent.%%.cleanupDuration for which stored values should be retained in the database. Format: <Time>,<Unit>
SystemEvent.%%.filterMessage types managed by housekeeping (comma-separated). Possible values: ERROR, WARNING, INFO
SystemEvent.%%.pollingPolling interval for deleting records. Format: <Time>,<Unit>
System.%%.limitMaximum number of messages deleted in one run
System.%%.starttimeTime at which housekeeping begins each day (00:00–23:59)
System.%%.endtimeTime at which housekeeping ends each day (00:00–23:59)

Business Transactions​

ParameterDescription
BusinessTransaction.cleanupDuration for which stored values should be retained in the database. Format: <Time>,<Unit>
BusinessTransaction.pollingPolling interval for deleting records. Format: <Time>,<Unit>
BusinessTransaction.limitMaximum number of messages deleted in one run
BusinessTransaction.starttimeTime at which housekeeping begins each day (00:00–23:59)
BusinessTransaction.endtimeTime at which housekeeping ends each day (00:00–23:59)

Process Events​

This section contains data stored per process, accessible in the monitor by double-clicking a process.

ProcessCleanup​

Define a list of housekeeping configurations. These names are solely for referencing the configuration, and any name can be used. Configure the following parameters for each name in this list (replace %% with the name).

ParameterDescription
ProcessCleanup.%%.cleanupDuration for which stored values should be retained in the database. Format: <Time>,<Unit>
ProcessCleanup.%%.filterProcess states managed by housekeeping (comma-separated). Possible values: SUCCESS, ABORTED
ProcessCleanup.%%.pollingPolling interval for deleting records. Format: <Time>,<Unit>
ProcessCleanup.%%.limitMaximum number of messages deleted in one run
ProcessCleanup.%%.starttimeTime at which housekeeping begins each day (00:00–23:59)
ProcessCleanup.%%.endtimeTime at which housekeeping ends each day (00:00–23:59)

Cleanup​

ParameterDescription
Cleanup.ORC_SYSLOG_QUEUE.limitMaximum number of syslog messages deleted at once (valid for MSSQL and Oracle)
Cleanup.ORC_TOPIC_QUEUE.limitMaximum number of signals deleted at once (valid for MSSQL and Oracle)
Cleanup.ORC_WORK_QUEUE.limitMaximum number of work items deleted at once (valid for MSSQL and Oracle)

Message Store​

This section enumerates all messages appearing in the runtime, stored for analysis in the monitor.

ParameterDescription
MessageStore.cleanupDuration for which stored values should be retained in the database. Format: <Time>,<Unit>
MessageStore.limitMaximum number of messages deleted in one run
MessageStore.pollingPolling interval for deleting records. Format: <Time>,<Unit>
MessageStore.starttimeTime at which housekeeping begins each day (00:00–23:59)
MessageStore.endtimeTime at which housekeeping ends each day (00:00–23:59)
MessageStore.block.sizeNumber of records to be deleted per SQL invocation
MessageStore.block.modeDeletion mode: ALL (commit after complete deletion), TABLE (commit per table), BLOCK (commit per block)

Enterprise Service Registry​

ParameterDescription
ESB.cleanupDuration for which stored values should be retained in the database. Format: <Time>,<Unit>
ESB.pollingPolling interval for deleting records. Format: <Time>,<Unit>
ESB.starttimeTime at which housekeeping begins each day (00:00–23:59)
ESB.endtimeTime at which housekeeping ends each day (00:00–23:59)

Long Time Archive​

ParameterDescription
LongtimeArchive.cleanupDuration for which stored values should be retained in the database. Format: <Time>,<Unit>
LongtimeArchive.pollingPolling interval for deleting records. Format: <Time>,<Unit>
LongtimeArchive.limitMaximum number of messages deleted in one run
LongtimeArchive.starttimeTime at which housekeeping begins each day (00:00–23:59)
LongtimeArchive.endtimeTime at which housekeeping ends each day (00:00–23:59)

Database Reorganization​

The Orchestra runtime database requires continual reorganization of its structures, including indexes and table statistics. This process ensures fast and efficient execution of database statements. The database job is designed to automatically reorganize the database without the need for additional jobs. Currently, reorganization is implemented solely for the Derby database. Future versions of Orchestra will introduce support for other databases.

ParameterDescription
DatabaseOptimization.pollingInterval for running database optimization. Format: <Time>,<Unit>
DatabaseOptimization.error.modeBehavior on error: STOP (terminate execution) or CONTINUE (skip to next statement)
DatabaseOptimization.suspend.processingtrue = pause Orchestra during reorganization; false = continue in parallel
DatabaseOptimization.starttimeTime at which housekeeping begins each day (00:00–23:59)
DatabaseOptimization.endtimeTime at which housekeeping ends each day (00:00–23:59)
DatabaseOptimization.lockTimeoutSeconds Orchestra waits for exclusive lock before starting reorganization
DatabaseOptimization.queryTimeoutSeconds Orchestra waits to execute SQL referencing reorganized tables
DatabaseOptimization.rotateAfterDuration (minutes) before switching to a new runtime table generation